DescribeGroupedVul
Description
call the DescribeGroupedVul interface to group query vulnerability information.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeGroupedVul
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
Type | BODY | string | No | cve | vulnerability type. Includes the following categories: cve:Linux vulnerability sys:Windows vulnerability cms:WebCMS vulnerability app: application vulnerability emg: emergency vulnerability |
PageSize | BODY | integer | No | 20 | The maximum number of pieces of data per page displayed during a paged query. The default value is 20. |
CurrentPage | BODY | integer | No | 1 | the page number of the current page displayed when querying. The starting value is 1 and the default value is 1. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
AliasName | BODY | string | No | RHSA-2019:0230-Important: polkit security update | vulnerability alias. |
Necessity | BODY | string | No | asap,later,nntf | vulnerability repair necessity level. Multiple levels are separated by English commas. Valid values: asap: high later: medium nntf: low |
Lang | BODY | string | No | zh | the language type of the request and receive message. zh: Chinese en: English |
Uuids | BODY | string | No | d42f938c-d962-48a0-90f9-05e4ea****** | asset instance unique ID list, multiple separated by English commas. |
Dealed | BODY | string | No | n | whether the vulnerability is handled. y: processed n: Unprocessed |
version | BODY | string | No | 2016-01-01 | version of api |
GroupId | BODY | string | No | weds**** | asset group ID. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
RequestId | string | 0DFCADBA-7065-42DA-AF17-6868B9C2A8CF | request ID of the result. |
PageSize | integer | 20 | The maximum number of pieces of data per page displayed during a paged query. |
GmtLast | long | 1554185744000 | the vulnerability was last discovered in milliseconds. |
LaterCount | integer | 0 | repair necessity level medium number of vulnerabilities. |
AsapCount | integer | 0 | repair necessity level high number of vulnerabilities. |
Name | string | *** glibc security and BUG fix update | vulnerability name. |
TotalCount | integer | 2 | the total number of query results. |
Type | string | cve | vulnerability type. Includes the following categories: cve:Linux vulnerability sys:Windows vulnerability cms:WebCMS vulnerability app: application vulnerability emg: emergency vulnerability |
CurrentPage | integer | 1 | the page number of the current page displayed when paging query. |
HandledCount | integer | 0 | number of processed vulnerabilities. |
GroupedVulItems | array | No sample value for this parameter. | group vulnerability information. |
AliasName | string | RHSA-2019:0230-Important: polkit security update | vulnerability alias. |
NntfCount | integer | 59 | repair necessity level low number of vulnerabilities. |
Tags | string | need to restart | vulnerability tag. |
Example
Successful Response example
{
"RequestId":"0DFCADBA-7065-42DA-AF17-6868B9C2A8CF",
"PageSize":"20",
"GmtLast":"1554185744000",
"LaterCount":"0",
"AsapCount":"0",
"Name":"*** glibc security and BUG fix update",
"TotalCount":"2",
"Type":"cve",
"CurrentPage":"1",
"HandledCount":"0",
"GroupedVulItems":"",
"AliasName":"RHSA-2019:0230-Important: polkit security update",
"NntfCount":"59",
"Tags":"need to restart"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}
title: DescribeInstanceStatistics
sidebar_position: 3
DescribeInstanceStatistics
Description
call the DescribeInstanceStatistics interface to query the risk statistics of the asset.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeInstanceStatistics
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
Uuid | BODY | string | Yes | a51cec37-ed73-4c53-b467-*** | unique ID list of asset instances. Separate multiple IDs with English commas. description to query the risk statistics of the asset, you need to provide the unique identification ID of the asset instance, which can be obtained by using the DescribeCloudCenterInstances interface. |
SourceIp | BODY | string | No | 1.2.3.4 | access source IP address. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
Lang | BODY | string | No | zh | the language type of the request and receive message. zh: Chinese en: English |
From | BODY | string | Yes | sas | data request source. Fixed as sas. |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
Account | integer | 1 | the grouping type of the asset. Valid values include: 0: default grouping 1: other groups |
RequestId | string | 7E0618A9-D5EF-4220-9471-C42B5E92719F | request ID of the result. |
Health | integer | 1 | number of baseline check problems. |
EmgNum | integer | 0 | number of emergency vulnerabilities. |
Data | array | No sample value for this parameter. | statistics of asset risk. |
Vul | integer | 4 | sum of all vulnerabilities: CveNum + EmgNum + SysNum + CmsNum + AppNum. |
AppNum | integer | 0 | number of applied vulnerabilities. |
Uuid | string | us1233****** | unique identification ID of the asset instance. |
Suspicious | integer | 2 | number of security alerts. |
CveNum | integer | 1 | number of Linux software vulnerabilities. |
Trojan | integer | 1 | number of trojans. |
CmsNum | integer | 2 | number of Web-CMS vulnerabilities. |
SysNum | integer | 1 | Windows the number of system vulnerabilities. |
Example
Successful Response example
{
"Account":"1",
"RequestId":"7E0618A9-D5EF-4220-9471-C42B5E92719F",
"Health":"1",
"EmgNum":"0",
"Data":"",
"Vul":"4",
"AppNum":"0",
"Uuid":"us1233******",
"Suspicious":"2",
"CveNum":"1",
"Trojan":"1",
"CmsNum":"2",
"SysNum":"1"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}